home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d11 / sos210.arc / SOS.DOC < prev   
Text File  |  1989-01-26  |  22KB  |  492 lines
  1.       Save Our Screens (SoS) v2.10  (c) 1987, 1988  Gary J. Shapiro
  2.                          - All Rights Reserved -
  3.                                May 3, 1988
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12. Save Our Screens (SoS) is distributed under the SHAREWARE concept.  It is
  13. NOT Public Domain.  An individual registration costs $20.00.
  14.  
  15. Please send check or money order payable to:
  16.  
  17.  
  18.                            Gary J. Shapiro
  19.                            6 Scenic Court
  20.                            Marlboro NJ,  07746
  21.  
  22.  
  23. Please include your name, address, and SoS version you are registering.
  24.  
  25.  
  26. All corporate, business, government or other commercial users of SoS, must
  27. be registered.  Please contact me for details on pricing and site license
  28. agreements.
  29.  
  30.  
  31. You are encouraged to make copies for others to evaluate, as well as for
  32. distribution on Bulletin Board Systems (BBS's).  However, you are not
  33. authorized to accept any payment for doing so.
  34.  
  35.  
  36. Suggestions?  Problems?  Bugs?  Please let me know.  Your help will only
  37. improve SoS.
  38.  
  39.  
  40.  
  41.  
  42. DISCLAIMER
  43. ----------
  44.  
  45. You are completely responsible for determining the fitness or usability of
  46. this package.  I will not be liable for any damages, of any kind, arising
  47. from any failure of any programs in this package to perform as expected.
  48.       Save Our Screens (SoS) v2.10  (c) 1987, 1988  Gary J. Shapiro
  49.  
  50.  
  51.  
  52. INTRODUCTION
  53. ------------
  54.  
  55. SoS is a Terminate and Stay Resident (TSR) program that allows you to save
  56. and restore text screens to memory and disk.  Up to 9 memory screens and
  57. 90 disk screens are available for this purpose.  SoS can be invoked within
  58. most text applications.  MDA, CGA, HGC, EGA, MCGA and VGA text modes are
  59. fully supported in 40 and 80 column mode.  A maximum of 50 rows is
  60. supported for users of EGA, VGA and similar display adapters.
  61.  
  62. SoS has the additional capability to save screen images to disk in
  63. Text/ASCII format.  Screens saved in this manner can be processed by any
  64. Text or ASCII handling program, eg. editors, word processors etc.
  65.  
  66. All SoS information is presented via POP-UP windows activated by a series
  67. of HOTKEYS.
  68.  
  69.  
  70. SYSTEM REQUIREMENTS
  71. -------------------
  72.  
  73. SoS requires an IBM PC/XT/AT/PS2 or true compatible that has it's display
  74. buffer at address 0b000h or 0b800h.  DOS 2.0 or later is required.
  75.  
  76. SoS with Extended Screen Support disabled, and a maximum of 1 screen will
  77. require approximately 11K.  Each additional screen will add 4K to this
  78. number.  The maximum total memory required is 42.5K with 9 screens
  79. requested.
  80.  
  81. With Extended Screen Support enabled add 8k to the above amounts.  The
  82. maximum total memory for this mode is 50K with 9 screens requested.
  83.       Save Our Screens (SoS) v2.10  (c) 1987, 1988  Gary J. Shapiro
  84.  
  85.  
  86.  
  87. INVOKING SoS
  88. ------------
  89.  
  90. SoS is invoked at the DOS command line or in a batch file as follows:
  91.  
  92.  A>SOS <Optional Parameters>
  93.  
  94.    Optional Parameters are:
  95.  
  96.      /Sn (n=1 to 9)  Maximum allowable number of screens to save/restore
  97.                      from memory.  S4 is the default.  Maximum number of
  98.                      disk screens is 10 times this number.  90 Text disk
  99.                      screens are always allowed for Text mode.
  100.  
  101.      /Rn (n=0 or 1)  Enable(1) or Disable(0) CGA snow detection.
  102.                      R1 is the default.
  103.  
  104.      /En (n=0 or 1)  Enable(1) or Disable(0) Extended Screen Support.
  105.                      E0 is the default.
  106.  
  107. If no parameters are specified, the default is to allow a maximum of 4
  108. screens with CGA snow detection enabled and Extended Screen Support
  109. disabled.  Just as if you specified SOS /S4 /R1 /E0.
  110.  
  111. The '/' must precede the parameter and at least one space must come
  112. between successive parameters.  The order of parameters is not important.
  113.  
  114. If you're using a display adapter that does not produce 'snow' you should
  115. specify /R0.  All IBM CGA users should specify /R1 or take the default.
  116. For all other adapters there is no need to specify this parameter.  SoS
  117. automatically assumes /R0 since these adapters do not produce 'snow'.  40
  118. column text, even with a CGA, doesn't produce 'snow', therefore /R0 is
  119. used for this mode.
  120.  
  121. Extended Screen Support (ESS) provides the ability to save and restore
  122. screens up to 80 columns by 50 rows in size.  This feature is designed for
  123. use with EGA, VGA and similar display adapters.  Please see the section on
  124. Extended Screen Support for a more detailed discussion of this feature.
  125.  
  126. SoS will inform you of parameter errors and will not let a second copy be
  127. loaded into memory.  If enough memory isn't available to load SoS, a
  128. message will be displayed.  In this case, you should decrease the number
  129. of screens requested by 1 until SoS successfully loads.  If it still won't
  130. load with 1 screen, you need additional memory on your system.  If SoS
  131. fails to load, ERRORLEVEL will be set to 1.
  132.  
  133.  
  134. COMPATIBILITY
  135. -------------
  136.  
  137. If you are using other TSR programs and SoS fails to function properly, or
  138. system problems are experienced, try changing the loading order of your
  139. programs.  While SoS was designed to 'behave well' some 'ill behaved'
  140. TSR's might cause problems.  Generally, if SoS is loaded first there
  141. should be no problems.  If you are using SIDEKICK, load SoS first to
  142. insure complete compatibility.
  143.       Save Our Screens (SoS) v2.10  (c) 1987, 1988  Gary J. Shapiro
  144.  
  145.  
  146.  
  147. ACTIVATING SoS
  148. --------------
  149.  
  150. Save to Memory
  151. --------------
  152. Press the Ctrl-LeftShift-S keys simultaneously.  At this point, a message
  153. will appear waiting for you to enter a number from 1 to the maximum number
  154. of screens specified when SoS was loaded (or 4 if the default was taken).
  155. Entering a valid number, followed by pressing the RETURN key, will cause
  156. SoS to save the screen image to memory under that number then return you
  157. to where you were.  SoS messages that appear will NOT be saved.  Only the
  158. original screen will be.  If you press an invalid key or a number out of
  159. range, an SoS message will be displayed.  At this point you can enter a
  160. valid number or press ESC to return to where you were.  A successful save
  161. will be be indicated by another SoS message.
  162.  
  163. Any existing memory images with the same screen number will be overlayed.
  164.  
  165.  
  166. Save to Disk
  167. ------------
  168. Press the Alt-LeftShift-S keys simultaneously.  As in a memory save you
  169. will be instructed to enter a number under which to save the screen image.
  170. Unlike memory saves however, you have the option to select what is known
  171. as a File Set number.  Pressing a function key, F1 through F10, will
  172. select the File Set number.  F1 will set it to 1, F2 to 2, and so on.  F10
  173. should be thought of as F0, since pressing this key results in a File Set
  174. number of 0.  File Set numbers range from 0 to 9.  You can press a
  175. function key as many times as you like in order to select the desired File
  176. Set number.
  177.  
  178. The File Set number, along with the subsequent screen number chosen, is
  179. used to create the filename to which the screen image will be saved.  A
  180. screen image to disk is always saved to the current directory.  The File
  181. Set number organizes the disk screens into 10 groups (0-9), with the
  182. screen number identifying the individual screen within the group.  The
  183. filename of a saved screen is as follows:
  184.  
  185.                SOS.0xy    x = File Set number  (GROUP  0-9)
  186.                           y = Screen number    (SCREEN 1-9)
  187.  
  188. This combination allows you to save to disk 10 times the number of screens
  189. specified when SoS was loaded.  If, for example, 9 screens were specified
  190. at SoS load time, then 90 unique disk screen images can be saved to the
  191. current directory.  Specifying 1 screen will result in the availability of
  192. 10 unique disk screens.
  193.  
  194. Initially the File Set number is 0.  When a screen is saved, the File Set
  195. number is 'remembered' and will become the default when SoS is next
  196. invoked for a disk function.
  197.  
  198. When the desired File Set number has been chosen, entering a screen number
  199. followed by pressing the RETURN key, will result in the screen being saved
  200. to disk.  If the screen image file already exists, you will be asked (Y/N)
  201. if you want to overwrite the file.
  202.       Save Our Screens (SoS) v2.10  (c) 1987, 1988  Gary J. Shapiro
  203.  
  204.  
  205.  
  206. To save a screen image in Text/ASCII format press the 'T' key (for Text).
  207. The word TEXT will appear in the SoS window (Pressing the 'T' key toggles
  208. between Text mode and Non-Text mode).  Saving a screen image while in Text
  209. mode will produce a screen saved as a Text file.  Screens saved in this
  210. manner can not be restored since they are not true screen images.  They
  211. are meant to be used by external programs that can process Text files.  As
  212. a result, 90 text screens can be saved to the same directory at all times
  213. regardless of the number of screens specified via the /S parameter at SoS
  214. load time.  The filename for Text screens are SOS.Txy.  Each text line
  215. ends with a Carriage Return/Line Feed combination.
  216.  
  217.  
  218. Restore from Memory
  219. -------------------
  220. Press the Ctrl-LeftShift-R keys simultaneously.  At this point, a message
  221. will appear waiting for to enter a number from 1 to the maximum number of
  222. screens specified when SoS was loaded (or 4 if the default was taken).
  223. Entering a valid number, followed by pressing the RETURN key, will cause
  224. SoS to restore that screen image number from memory.  If you press an
  225. invalid key or a number out of range, an SoS message will be displayed.
  226. At this point you can enter a valid number or press ESC to return to where
  227. you were.  A successful save will be indicated by another SoS message.
  228.  
  229. If a valid number is specified, the saved screen image will appear.  At
  230. this point you can enter another screen number which will pop up the SoS
  231. window.  Pressing the RETURN key will make the screen image appear.  Of
  232. course you can change the screen number first.  To exit from this mode
  233. press the ESC key.  This will return you to where you were prior to
  234. activating SoS.
  235.  
  236. Entering a valid screen number, but one that has not been previously saved
  237. to, will result in an SoS message indicating so.
  238.  
  239. You can also cycle through your saved screens by pressing the SPACE BAR.
  240. The cycling will start at screen 1 if SoS has just been activated, or at
  241. the next screen if a screen is already being displayed.  If cycling is
  242. begun when a screen number has been chosen but not restored, the screen
  243. number displayed will be the first screen restored.  Cycling and screen
  244. selection by number can be intermixed.
  245.  
  246.  
  247. Restore from Disk
  248. -----------------
  249. Press the Alt-LeftShift-R keys simultaneously.  A File Set number can be
  250. chosen if need be and the same actions followed as restoring from memory.
  251. The saved image is read from the SOS.0xy file that has a matching File Set
  252. number and screen number on the current directory.  The File Set number
  253. can be changed at any time resulting in a new group of disk images to be
  254. restored.
  255.  
  256. As in a restore from memory, the disk image restored will overlay the
  257. corresponding screen image in memory with the same screen number.  The
  258. screen number is the rightmost number that makes up the filename, ie. the
  259. 'y' in SOS.0xy.
  260.  
  261. Cycling through disk images is based on the screen number within the
  262. specified File Set number.  During cycling it is permissible to change the
  263. File Set number, which will enable a new group of disk images to be
  264. restored.
  265.       Save Our Screens (SoS) v2.10  (c) 1987, 1988  Gary J. Shapiro
  266.  
  267.  
  268.  
  269. SCREEN MANAGEMENT
  270. -----------------
  271.  
  272. It is up to you to keep track of all saved screen images.  Memory saves
  273. are fairly easy to manage since there are, at most, only 9 at one time.
  274. Disk screen images however, are somewhat more difficult to manage.
  275.  
  276. To aid in managing disk screens, the File Set number comes in handy.  If
  277. you save a particular application's screens to the same File Set number,
  278. or series of numbers, it is easier to keep track of what's stored out on
  279. disk.  For example, if you are in a LOTUS session you might save all your
  280. screens to File Set 0 and 1.  This will provide up to 20 disk screens.  If
  281. you then get into your favorite word processor, you might save it's screen
  282. images to File Set 3.  This will provide up to 10 disk screens.
  283.  
  284. Restoring screens then becomes easier since you have grouped your
  285. applications by File Set number.  Once you set the correct File Set number
  286. you can then restore the screen number that you need or cycle through all
  287. the screens within the File Set number.  Just keep in mind that disk
  288. restores overlay memory saved screens that have the same screen number.
  289.  
  290.  
  291. SCREEN INFORMATION
  292. ------------------
  293.  
  294. When doing a screen restore from memory or disk, you sometimes can't
  295. remember which screen number you are currently displaying.  This is
  296. especially true if you are cycling through many screens.
  297.  
  298. To determine which screen number is currently being displayed, enter a '?'
  299. when in RESTORE mode.  The screen number you are currently viewing will
  300. then appear.  If a disk restore is being requested the File Set number
  301. will be displayed.  From here you can continue restoring other screens or
  302. return to the current screen by entering the ACTIVE screen number.
  303.  
  304. In SAVE mode this function is meaningless and the `?` is treated as an
  305. invalid key.
  306.       Save Our Screens (SoS) v2.10  (c) 1987, 1988  Gary J. Shapiro
  307.  
  308.  
  309.  
  310. EXTENDED SCREEN SUPPORT
  311. -----------------------
  312.  
  313. Extended Screen Support (ESS) is the ability for SoS to save and restore
  314. screen images greater then 80 columns by 25 rows.  It is activated by
  315. specifying /E1 at SoS load time.  A maximum screen size of 80x50 is
  316. supported.  If a screen exceeds 80x50, only this amount is saved or
  317. restored.  Since most applications utilize an 80x25 screen size, the
  318. default is to disable ESS (/E0).  This provides saving/restoring a maximum
  319. screen image of 80x25 regardless of the actual screen size in affect.  If
  320. you can't or never plan on using extended screen sizes take the default,
  321. /E0, which will save you 8k of memory.
  322.  
  323. When using ESS please consider the following:
  324.  
  325. 1. As with any screen size, SoS restores screens from memory or disk based
  326.    on the CURRENT screen size, NOT the screen size that was active when
  327.    the image was saved.  Depending on the current screen size, you might
  328.    see less data or data remaining from the original screen.
  329.  
  330. 2. Any screen image greater then 80x25 will require two consecutive memory
  331.    screens.  This means for example, that saving to memory or restoring
  332.    from disk, a screen image to memory screen #1 will not only fill that
  333.    screen in memory but will also use the next consecutive screen, #2 in
  334.    this case. SoS will allow #2 to be restored from memory even though a
  335.    screen image was not saved under this number.  This is a feature only
  336.    applicable to ESS mode.  This is particularly useful when restoring an
  337.    80x50 screen image while in an 80x25 screen.  To see the entire 80x50
  338.    screen image just restore screens #1 and #2 from memory.
  339.  
  340.    Disk saves with ESS are the same as without ESS except that the
  341.    resulting files are larger.  Disk restores are processed in the same
  342.    way as memory saves, ie. two consecutive memory screens are used.
  343.  
  344.    Screens saved to the maximum screen number as specified at SoS load
  345.    time are possible.  There is an extra memory screen space available
  346.    beyond the highest screen.  It can not be referenced directly however.
  347.  
  348. 3. As a rule, if a screen image is restored to the same size screen in
  349.    which it was saved, it will be displayed as it originally appeared.
  350.  
  351. 4. Screen sizes greater then 80x50 can be processed by SoS.  However, only
  352.    the beginning 80x50 area will be saved and subsequently restored.
  353.  
  354. 5. Since extended screens occupy two memory screens, the number of screens
  355.    of this type, that can be saved or restored, is reduced.
  356.  
  357.  
  358. You will soon discover that restored extended screen images can result in
  359. some unexpected looking screens especially if a screen image is restored
  360. to a screen size that is different than the one in which it was saved
  361. from.  To get an idea of what this means, consider the following examples
  362. of screen saves to memory.  Note that these examples also apply to disk
  363. restores after they are in memory.
  364.       Save Our Screens (SoS) v2.10  (c) 1987, 1988  Gary J. Shapiro
  365.  
  366.  
  367.  
  368. o  An 80x25 screen image is saved to #1.  Another 80x25 screen image is
  369.    saved to #2.  You now switch to an 80x50 screen size.  Screen #1 is
  370.    restored.  What you will see is screen #1 AND screen #2.  Remember,
  371.    data is restored to fit the current screen size.
  372.  
  373. o  You now restore screen #2.  You will see #2 on the upper portion and
  374.    empty space in the lower half.  Since SoS is restoring data to fit the
  375.    screen size, #3 is also restored.  Since #3 never had a screen saved to
  376.    it, it is blank.
  377.  
  378. o  Suppose you now save an 80x50 screen to #2.  Restoring #2 while in an
  379.    80x50 mode will display the screen as it originally appeared.  If you
  380.    now restored screen #1 you would see #1 in the top half of the screen
  381.    and #2 in the bottom.
  382.  
  383.  
  384. With a little practice you will quickly get the feel for processing
  385. extended screens.
  386.       Save Our Screens (SoS) v2.10  (c) 1987, 1988  Gary J. Shapiro
  387.  
  388.  
  389.  
  390. ERRORS
  391. ------
  392.  
  393. Any errors that are encountered during SoS processing will be indicated by
  394. an error message and are self explanatory.  In most cases, you should try
  395. to correct the problem then retry the operation.  Entering ESC will
  396. immediately exit you from SoS back to where you were if all else fails.
  397.  
  398.  
  399. TIPS ON USING SoS
  400. -----------------
  401.  
  402. The more you use SoS, the more uses you will discover for it.  To help you
  403. along, consider some of these:
  404.  
  405. o  The ability to save important screen information from one application
  406.    to be referenced in another.
  407.  
  408. o  The ability to make customized HELP screens with the use of an editor.
  409.  
  410. o  Saved screens can provide an audit trail of past work.
  411.  
  412. o  Saved screens can be used to recover past work or even data in the
  413.    event of accidental loss due to machine failure or human error.
  414.  
  415. o  Saved screens can be used for tutorial purposes to aid in training.
  416.  
  417. o  Screens saved in Text mode can be incorporated into documents via a
  418.    word processor or editor.
  419.  
  420.  
  421. MISCELLANEOUS
  422. -------------
  423.  
  424. Saves and restores within graphic modes are not supported.  If you try to
  425. activate SoS in a graphics mode, the request will be ignored.
  426.  
  427. All pages are supported within SoS.  SoS will always restore to the
  428. current page, not the one in which the screen image was saved.
  429.  
  430. Once a screen image is saved you can save any number of other screens
  431. under that same screen number.  Just keep in mind that the last one saved
  432. is what you will see when doing a restore function.
  433.  
  434. Disk screen images can be saved and used between sessions.  They are not
  435. tied to the session which created them.  Memory screen images on the
  436. otherhand cease to exist when the machine is turned off.
  437.  
  438. The 90 disk screen limit is applicable within the same directory.  You can
  439. literally have 100's of disk screen images among different directories.
  440.  
  441. The SOS.0xy files can be deleted when not needed.  Each 80x25 screen image
  442. file is 4000 bytes in length.  Each 40x25 screen image file is 2000 bytes
  443. in length.  The size of an extended screen file can be determined by the
  444. following formula.
  445.  
  446.           ( Number of Screen Rows * Number of Screen Columns ) * 2
  447.  
  448. The SOS.Txy files are one half the size of the SOS.0xy files.
  449.       Save Our Screens (SoS) v2.10  (c) 1987, 1988  Gary J. Shapiro
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456. HISTORY OF CHANGES
  457. ------------------
  458.  
  459. V1.01,  July 07, 1987  -  First official release of Save Our Screens (SoS).
  460.  
  461. V1.02,  July 13, 1987  -  Fixed a minor problem with the critical error
  462.                           handling routine during a disk restore.
  463.                        -  Added restore screen cycling via the SPACE BAR.
  464.  
  465. V1.03, March 03, 1988  -  Internal memory improvements.
  466.                        -  Added support for MCGA and VGA display adapters.
  467.                        -  Added PS/2 support.
  468.                        -  Added ability to remove SoS from memory.
  469.                        -  Added ERRORLEVEL setting for load failures.
  470.  
  471. V1.04, March 20, 1988  -  Eliminated the ability to remove SoS.  (Suggest
  472.                             that one of the many TSR managers be used for
  473.                             this if required.)
  474.                        -  Added memory utilization statistics at load time.
  475.                        -  Added screen information via the '?' key while
  476.                           doing restores.
  477.                        -  Internal improvements to make SoS more
  478.                           compatible with other TSR's.
  479.                        -  Cosmetic changes to the SoS pop-up windows.
  480.  
  481. V2.00, April 17, 1988  -  Provide full support for screen sizes up to
  482.                           80x50 (EGA, VGA and similar display adapters).
  483.                        -  Increased the maximum number of memory screens
  484.                           from 8 to 9.
  485.                        -  Increased the maximum number of screen images
  486.                           to disk from 9 to 90.
  487.  
  488. V2.10  May 5, 1988     -  SoS now requires the RETURN key to be pressed
  489.                           after selecting a screen.
  490.                        -  Added a Text mode for disk saves.
  491.  
  492.